<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span><a name="line.1"></a>
<span class="sourceLineNo">002</span>/*<a name="line.2"></a>
<span class="sourceLineNo">003</span> * Copyright (C) 2014 Archie L. Cobbs. All rights reserved.<a name="line.3"></a>
<span class="sourceLineNo">004</span> *<a name="line.4"></a>
<span class="sourceLineNo">005</span> * $Id: MsrpMessage.html 5 2014-12-10 22:27:01Z archie.cobbs $<a name="line.5"></a>
<span class="sourceLineNo">006</span> */<a name="line.6"></a>
<span class="sourceLineNo">007</span><a name="line.7"></a>
<span class="sourceLineNo">008</span>package org.dellroad.msrp.msg;<a name="line.8"></a>
<span class="sourceLineNo">009</span><a name="line.9"></a>
<span class="sourceLineNo">010</span>import java.io.ByteArrayOutputStream;<a name="line.10"></a>
<span class="sourceLineNo">011</span>import java.io.IOException;<a name="line.11"></a>
<span class="sourceLineNo">012</span>import java.io.OutputStream;<a name="line.12"></a>
<span class="sourceLineNo">013</span>import java.io.OutputStreamWriter;<a name="line.13"></a>
<span class="sourceLineNo">014</span>import java.util.concurrent.ThreadLocalRandom;<a name="line.14"></a>
<span class="sourceLineNo">015</span>import java.util.regex.Pattern;<a name="line.15"></a>
<span class="sourceLineNo">016</span><a name="line.16"></a>
<span class="sourceLineNo">017</span>import org.dellroad.msrp.MsrpConstants;<a name="line.17"></a>
<span class="sourceLineNo">018</span><a name="line.18"></a>
<span class="sourceLineNo">019</span>/**<a name="line.19"></a>
<span class="sourceLineNo">020</span> * MSRP request/response support superclass.<a name="line.20"></a>
<span class="sourceLineNo">021</span> */<a name="line.21"></a>
<span class="sourceLineNo">022</span>public abstract class MsrpMessage {<a name="line.22"></a>
<span class="sourceLineNo">023</span><a name="line.23"></a>
<span class="sourceLineNo">024</span>    private final String transactionId;<a name="line.24"></a>
<span class="sourceLineNo">025</span>    private final MsrpHeaders headers;<a name="line.25"></a>
<span class="sourceLineNo">026</span><a name="line.26"></a>
<span class="sourceLineNo">027</span>    /**<a name="line.27"></a>
<span class="sourceLineNo">028</span>     * Default constructor. Generates a random transaction ID.<a name="line.28"></a>
<span class="sourceLineNo">029</span>     */<a name="line.29"></a>
<span class="sourceLineNo">030</span>    protected MsrpMessage() {<a name="line.30"></a>
<span class="sourceLineNo">031</span>        this(null, null);<a name="line.31"></a>
<span class="sourceLineNo">032</span>    }<a name="line.32"></a>
<span class="sourceLineNo">033</span><a name="line.33"></a>
<span class="sourceLineNo">034</span>    /**<a name="line.34"></a>
<span class="sourceLineNo">035</span>     * Construct an instance with the given transaction ID and headers.<a name="line.35"></a>
<span class="sourceLineNo">036</span>     *<a name="line.36"></a>
<span class="sourceLineNo">037</span>     * @param transactionId transaction ID, or null to have a randomly generated one assigned<a name="line.37"></a>
<span class="sourceLineNo">038</span>     * @param headers MSRP headers, or null to have an empty instance created<a name="line.38"></a>
<span class="sourceLineNo">039</span>     * @throws IllegalArgumentException if {@code transactionId} is invalid<a name="line.39"></a>
<span class="sourceLineNo">040</span>     */<a name="line.40"></a>
<span class="sourceLineNo">041</span>    protected MsrpMessage(String transactionId, MsrpHeaders headers) {<a name="line.41"></a>
<span class="sourceLineNo">042</span>        this.transactionId = transactionId != null ? transactionId : MsrpMessage.randomId();<a name="line.42"></a>
<span class="sourceLineNo">043</span>        if (!Pattern.compile(Util.IDENT_REGEX).matcher(this.transactionId).matches())<a name="line.43"></a>
<span class="sourceLineNo">044</span>            throw new IllegalArgumentException("invalid transaction ID `" + this.transactionId + "'");<a name="line.44"></a>
<span class="sourceLineNo">045</span>        this.headers = headers != null ? headers : new MsrpHeaders();<a name="line.45"></a>
<span class="sourceLineNo">046</span>    }<a name="line.46"></a>
<span class="sourceLineNo">047</span><a name="line.47"></a>
<span class="sourceLineNo">048</span>    /**<a name="line.48"></a>
<span class="sourceLineNo">049</span>     * Get the transaction ID associated with this instance.<a name="line.49"></a>
<span class="sourceLineNo">050</span>     */<a name="line.50"></a>
<span class="sourceLineNo">051</span>    public String getTransactionId() {<a name="line.51"></a>
<span class="sourceLineNo">052</span>        return this.transactionId;<a name="line.52"></a>
<span class="sourceLineNo">053</span>    }<a name="line.53"></a>
<span class="sourceLineNo">054</span><a name="line.54"></a>
<span class="sourceLineNo">055</span>    /**<a name="line.55"></a>
<span class="sourceLineNo">056</span>     * Get the headers associated with this instance.<a name="line.56"></a>
<span class="sourceLineNo">057</span>     */<a name="line.57"></a>
<span class="sourceLineNo">058</span>    public MsrpHeaders getHeaders() {<a name="line.58"></a>
<span class="sourceLineNo">059</span>        return this.headers;<a name="line.59"></a>
<span class="sourceLineNo">060</span>    }<a name="line.60"></a>
<span class="sourceLineNo">061</span><a name="line.61"></a>
<span class="sourceLineNo">062</span>    /**<a name="line.62"></a>
<span class="sourceLineNo">063</span>     * Encode this instance according to RFC 4975.<a name="line.63"></a>
<span class="sourceLineNo">064</span>     *<a name="line.64"></a>
<span class="sourceLineNo">065</span>     * @param withBody true to include the body, or false to omit the body, if any<a name="line.65"></a>
<span class="sourceLineNo">066</span>     */<a name="line.66"></a>
<span class="sourceLineNo">067</span>    public byte[] encode(boolean withBody) {<a name="line.67"></a>
<span class="sourceLineNo">068</span>        try {<a name="line.68"></a>
<span class="sourceLineNo">069</span>            final ByteArrayOutputStream buf = new ByteArrayOutputStream();<a name="line.69"></a>
<span class="sourceLineNo">070</span>            final OutputStreamWriter bufWriter = new OutputStreamWriter(buf, Util.UTF8);<a name="line.70"></a>
<span class="sourceLineNo">071</span>            bufWriter.write(this.getFirstLine());<a name="line.71"></a>
<span class="sourceLineNo">072</span>            bufWriter.write(Util.CRLF);<a name="line.72"></a>
<span class="sourceLineNo">073</span>            bufWriter.write(this.headers.toString());<a name="line.73"></a>
<span class="sourceLineNo">074</span>            bufWriter.flush();<a name="line.74"></a>
<span class="sourceLineNo">075</span>            if (withBody)<a name="line.75"></a>
<span class="sourceLineNo">076</span>                this.writePayload(buf);<a name="line.76"></a>
<span class="sourceLineNo">077</span>            bufWriter.write(MsrpConstants.END_LINE_PREFIX);<a name="line.77"></a>
<span class="sourceLineNo">078</span>            bufWriter.write(this.transactionId);<a name="line.78"></a>
<span class="sourceLineNo">079</span>            bufWriter.write(this.getFlagByte() &amp; 0xff);<a name="line.79"></a>
<span class="sourceLineNo">080</span>            bufWriter.write(Util.CRLF);<a name="line.80"></a>
<span class="sourceLineNo">081</span>            bufWriter.flush();<a name="line.81"></a>
<span class="sourceLineNo">082</span>            return buf.toByteArray();<a name="line.82"></a>
<span class="sourceLineNo">083</span>        } catch (IOException e) {<a name="line.83"></a>
<span class="sourceLineNo">084</span>            throw new RuntimeException("unexpected exception");<a name="line.84"></a>
<span class="sourceLineNo">085</span>        }<a name="line.85"></a>
<span class="sourceLineNo">086</span>    }<a name="line.86"></a>
<span class="sourceLineNo">087</span><a name="line.87"></a>
<span class="sourceLineNo">088</span>    /**<a name="line.88"></a>
<span class="sourceLineNo">089</span>     * Generate a random identifier for use as transaction or message ID.<a name="line.89"></a>
<span class="sourceLineNo">090</span>     */<a name="line.90"></a>
<span class="sourceLineNo">091</span>    public static String randomId() {<a name="line.91"></a>
<span class="sourceLineNo">092</span>        return String.format("%016x", ThreadLocalRandom.current().nextLong());<a name="line.92"></a>
<span class="sourceLineNo">093</span>    }<a name="line.93"></a>
<span class="sourceLineNo">094</span><a name="line.94"></a>
<span class="sourceLineNo">095</span>// Object<a name="line.95"></a>
<span class="sourceLineNo">096</span><a name="line.96"></a>
<span class="sourceLineNo">097</span>    @Override<a name="line.97"></a>
<span class="sourceLineNo">098</span>    public boolean equals(Object obj) {<a name="line.98"></a>
<span class="sourceLineNo">099</span>        if (obj == this)<a name="line.99"></a>
<span class="sourceLineNo">100</span>            return true;<a name="line.100"></a>
<span class="sourceLineNo">101</span>        if (obj == null || obj.getClass() != this.getClass())<a name="line.101"></a>
<span class="sourceLineNo">102</span>            return false;<a name="line.102"></a>
<span class="sourceLineNo">103</span>        final MsrpMessage that = (MsrpMessage)obj;<a name="line.103"></a>
<span class="sourceLineNo">104</span>        if (!(this.transactionId != null ? this.transactionId.equals(that.transactionId) : that.transactionId == null))<a name="line.104"></a>
<span class="sourceLineNo">105</span>            return false;<a name="line.105"></a>
<span class="sourceLineNo">106</span>        if (!(this.headers != null ? this.headers.equals(that.headers) : that.headers == null))<a name="line.106"></a>
<span class="sourceLineNo">107</span>            return false;<a name="line.107"></a>
<span class="sourceLineNo">108</span>        return true;<a name="line.108"></a>
<span class="sourceLineNo">109</span>    }<a name="line.109"></a>
<span class="sourceLineNo">110</span><a name="line.110"></a>
<span class="sourceLineNo">111</span>    @Override<a name="line.111"></a>
<span class="sourceLineNo">112</span>    public int hashCode() {<a name="line.112"></a>
<span class="sourceLineNo">113</span>        return (this.transactionId != null ? this.transactionId.hashCode() : 0)<a name="line.113"></a>
<span class="sourceLineNo">114</span>          ^ (this.headers != null ? this.headers.hashCode() : 0);<a name="line.114"></a>
<span class="sourceLineNo">115</span>    }<a name="line.115"></a>
<span class="sourceLineNo">116</span><a name="line.116"></a>
<span class="sourceLineNo">117</span>    @Override<a name="line.117"></a>
<span class="sourceLineNo">118</span>    public String toString() {<a name="line.118"></a>
<span class="sourceLineNo">119</span>        return new String(this.encode(false), Util.UTF8);<a name="line.119"></a>
<span class="sourceLineNo">120</span>    }<a name="line.120"></a>
<span class="sourceLineNo">121</span><a name="line.121"></a>
<span class="sourceLineNo">122</span>// Subclass methods<a name="line.122"></a>
<span class="sourceLineNo">123</span><a name="line.123"></a>
<span class="sourceLineNo">124</span>    /**<a name="line.124"></a>
<span class="sourceLineNo">125</span>     * Get the end line flag byte.<a name="line.125"></a>
<span class="sourceLineNo">126</span>     */<a name="line.126"></a>
<span class="sourceLineNo">127</span>    protected abstract byte getFlagByte();<a name="line.127"></a>
<span class="sourceLineNo">128</span><a name="line.128"></a>
<span class="sourceLineNo">129</span>    /**<a name="line.129"></a>
<span class="sourceLineNo">130</span>     * Get the first message line.<a name="line.130"></a>
<span class="sourceLineNo">131</span>     */<a name="line.131"></a>
<span class="sourceLineNo">132</span>    protected abstract String getFirstLine();<a name="line.132"></a>
<span class="sourceLineNo">133</span><a name="line.133"></a>
<span class="sourceLineNo">134</span>    /**<a name="line.134"></a>
<span class="sourceLineNo">135</span>     * Write the message body, if any.<a name="line.135"></a>
<span class="sourceLineNo">136</span>     *<a name="line.136"></a>
<span class="sourceLineNo">137</span>     * &lt;p&gt;<a name="line.137"></a>
<span class="sourceLineNo">138</span>     * If this message has a body, this method should output CRLF, followed by the binary body content, followed by a final CRLF.<a name="line.138"></a>
<span class="sourceLineNo">139</span>     * If this message has no body, this method should not output anything.<a name="line.139"></a>
<span class="sourceLineNo">140</span>     * &lt;p&gt;<a name="line.140"></a>
<span class="sourceLineNo">141</span>     */<a name="line.141"></a>
<span class="sourceLineNo">142</span>    protected abstract void writePayload(OutputStream output) throws IOException;<a name="line.142"></a>
<span class="sourceLineNo">143</span>}<a name="line.143"></a>
<span class="sourceLineNo">144</span><a name="line.144"></a>




























































</pre>
</div>
</body>
</html>
